iT邦幫忙

2024 iThome 鐵人賽

DAY 3
0
Modern Web

從 0 到 1:30 篇文章帶你玩轉 Electron 與 React系列 第 3

Electron 和 React 的環境設定

  • 分享至 

  • xImage
  •  

要開始開發一個基於 ElectronReact 的桌面應用,首先我們需要正確配置開發環境。這篇文章將一步步的完成環境設置,包括安裝必要的工具、建立專案目錄結構,以及開發設定,讓讀者能夠快速進入實際開發階段。

第一步:安裝 Node.js

在開始之前,我們需要安裝 Node.js,它是 Electron 和 React 項目所需的運行環境。
可以通過以下步驟來安裝 Node.js:

  1. 前往 Node.js 官方網站
  2. 下載並安裝最新的 LTS(Long Term Support)版本,以確保穩定性。

在這邊提供一個筆者愛用的 Node 版本管理工具:NVM

NVM(Node Version Manager)是一個用來管理多個 Node.js 版本的工具。它可以幫助開發者輕鬆地在同一台電腦上安裝、切換和管理不同版本的 Node.js,這對於開發和測試環境中的兼容性問題尤其有用。

https://ithelp.ithome.com.tw/upload/images/20240917/20149301KPU6SMQy8Y.png
取自 Github Intro

NVM 有以下優點:

  1. 多版本管理:可以安裝並同時管理多個不同版本的 Node.js,並根據不同的專案需求快速切換 Node.js 版本,解決了在多個專案之間版本不一致的問題。
  2. 簡單易用:安裝和使用非常簡單,透過簡單的命令就能安裝和切換 Node.js 版本。例如,nvm install x.x.x 安裝指定版本,nvm use x.x.x 切換到指定版本。

安裝 NVM

照著 NVM 的 Github 說明一步一步做即可完成

  1. 下載腳本指令並執行安裝
wget -qO- https://raw.githubusercontent.com/nvm-sh/nvm/v0.40.1/install.sh | bash
  1. 將以下的指令加到指定檔案中(~/.bash_profile, ~/.zshrc, ~/.profile, or ~/.bashrc)
export NVM_DIR="$([ -z "${XDG_CONFIG_HOME-}" ] && printf %s "${HOME}/.nvm" || printf %s "${XDG_CONFIG_HOME}/nvm")"
[ -s "$NVM_DIR/nvm.sh" ] && \. "$NVM_DIR/nvm.sh" # This loads nvm

如此一來,NVM 已安裝到本機中,可以使用相關指令來安裝 Node 環境了

  1. 查看目前的所有版本
nvm ls-remote

https://ithelp.ithome.com.tw/upload/images/20240917/20149301qvg4peFXgx.png
可以安裝最新穩定的版本
2. 安裝指定版本的 Node 環境(v20.17.0 為例)

nvm install v20.17.0

https://ithelp.ithome.com.tw/upload/images/20240917/20149301AUJruqjLih.png
3. 切換版本

nvm use v20.17.0
Now using node v20.17.0 (npm v10.8.2)
  1. 查看本機的版本狀態
nvm ls

https://ithelp.ithome.com.tw/upload/images/20240917/20149301YsnpQPFjvR.png
5. 查看 Node & NPM

node -v #v20.17.0
npm -v #10.8.2

如此一來,我們可以在不同的使用場景中使用不同版本的 Node 環境,幫助我們管理不同環境的套件及設定。

建立一個 React 專案

接下來,我們將使用 Vite 來創建一個基於 React 專案。
Vite 是一個極速的開發工具,與傳統的 Create React App 相比,Vite 擁有更快的啟動速度和即時熱更新(HMR),讓開發者體驗更加流暢。

照著官網的步驟可以快速建立一個 React 專案:

  1. 在 command line 執行以下命令來初始化 vite 專案
npm create vite@latest my-electron-react-app --template react
  1. 進入專案目錄並安裝套件
cd my-electron-react-app
npm install
  1. 啟動開發伺服器
npm run dev

打開目錄可以觀察目錄結構:
https://ithelp.ithome.com.tw/upload/images/20240917/20149301LBXysvWXAy.png

安裝並設定 Electron

可以到 electron 官網/quick start 查看安裝步驟:

  1. 在專案目錄下安裝 Electron
npm install electron --save-dev
  1. 創建 Electron 的主程序文件。在專案根目錄下,新增一個 main.js 文件,並添加以下內容:
import { app, BrowserWindow } from 'electron';
import path from 'path';
import { fileURLToPath } from 'url';

const __filename = fileURLToPath(import.meta.url);
const __dirname = path.dirname(__filename);

function createWindow() {
  const mainWindow = new BrowserWindow({
    width: 800,
    height: 600,
    webPreferences: {
      preload: path.join(__dirname, 'preload.js'),
      nodeIntegration: true,
    },
  });

  mainWindow.loadURL('http://localhost:3000');
}

app.whenReady().then(() => {
  createWindow();

  app.on('activate', () => {
    if (BrowserWindow.getAllWindows().length === 0) {
      createWindow();
    }
  });
});

app.on('window-all-closed', () => {
  if (process.platform !== 'darwin') {
    app.quit();
  }
});

這段程式的作用我們使用 Electron 的 BrowserWindow 創建了一個視窗,並指向了我們的 React 程式,接下來我們可以啟動試試看

  1. 設定 package.json
    找到 package.json,並在 scripts 部分加上以下指令:
"scripts": {
  "start": "vite",
  "electron": "electron .",
  "dev": "vite --port 3000 & npm run electron"
}

這些腳本的作用是:

  • start:啟動 Vite 的開發伺服器。
  • electron:啟動 Electron 程式。
  • dev:同時啟動 Vite 和 Electron,實現即時更新以及桌面程式的同步運行。
  1. 執行 npm run dev
    會看到開啟一個視窗並且呈現 react 模板頁面
    https://ithelp.ithome.com.tw/upload/images/20240917/20149301DW978jRxVg.png

總結:

這篇文章詳細介紹了 ElectronReact 的環境設定,並展示了如何透過 Vite 來快建立開發環境,並使用 Vite 作為開發工具加速開發過程。


上一篇
系列目錄:Electron 和 React 開發之旅
下一篇
第一個 Electron + React 專案:建立基本應用程式
系列文
從 0 到 1:30 篇文章帶你玩轉 Electron 與 React30
圖片
  直播研討會
圖片
{{ item.channelVendor }} {{ item.webinarstarted }} |
{{ formatDate(item.duration) }}
直播中

尚未有邦友留言

立即登入留言